Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links and some typos #466

Merged
merged 1 commit into from
Oct 11, 2024

Conversation

ncclementi
Copy link
Contributor

I was going over the docs and found multiple broken links and some typos, so I went ahead and fix them. In some situations I wasn't sure about the correct link, please double check they are pointing to were they are supposed to.

@ncclementi ncclementi requested a review from a team as a code owner October 10, 2024 21:03
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -277,7 +277,7 @@
" \n",
"Optuna uses [studies](https://optuna.readthedocs.io/en/stable/reference/study.html) and [trials](https://optuna.readthedocs.io/en/stable/reference/trial.html) to keep track of the HPO experiments. Put simply, a trial is a single call of the objective function while a set of trials make up a study. We will pick the best observed trial from a study to get the best parameters that were used in that run.\n",
"\n",
"Here, `DaskStorage` class is used to set up a storage shared by all workers in the cluster. Learn more about what storages can be used [here](https://optuna.readthedocs.io/en/stable/tutorial/distributed.html)\n",
"Here, `DaskStorage` class is used to set up a storage shared by all workers in the cluster. Learn more about what storages can be used [here](https://optuna.readthedocs.io/en/stable/reference/storages.html)\n",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a new distributed tutorial in the optuna page see https://optuna.readthedocs.io/en/stable/tutorial/10_key_features/004_distributed.html, but it doesn't point to any storage docs, so I'm suggesting pointing to the storage docs. That being said, there is no reference there to DaskStorage since this is under optuna-integrations.

@@ -226,7 +226,7 @@ spec:
```

For the scheduler pod we are also setting the `rapidsai/base` container image, mainly to ensure our Dask versions match between
the scheduler and workers. We also disable Jupyter and ensure that the `dask-scheduler` command is configured.
the scheduler and workers. We ensure that the `dask-scheduler` command is configured.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is something missing in the yaml file that actually disables Jupyter, but it's not clear to me. Please correct if I'm wrong.

@ncclementi
Copy link
Contributor Author

The CI failure is related to #463. there is a problem with the new sphinx release v8.1

Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Naty this looks great!

@jacobtomlinson jacobtomlinson merged commit 7ed98fb into rapidsai:main Oct 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants